Interface OSPFNeighborTable

All Superinterfaces:
IPCObject
All Known Implementing Classes:
OSPFNeighborTableImpl

public interface OSPFNeighborTable extends IPCObject
Information provided by the PKI file:

    \class OspfNeighborTable
    
    \brief OspfNeighborTable handles and manipulates OSPF neighbor tables.
    
    \example network().getDevice("Router0").getProcess("OspfMainProcess").getOspfProcessAt(0).getAreaAt(0).getNeighborTable("Serial0/0/0")
    
Author:
Auto-generated
  • Method Details

    • getNeighborAt

      OSPFNeighbor getNeighborAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the neighbor at the specified index.
          
          \param index, the index of the neighbor of interest.
          
          \return OspfNeighbor, the OspfNeighbor object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      OSPFNeighbor Returns a OSPFNeighbor
    • getNeighborCount

      int getNeighborCount()
      Information provided by the PKI file:
      
          \brief Returns the number of neighbors.
          
          \return int, the number of neighbors.
          
              
      Returns:
      int Returns a int
    • getPort

      RouterPort getPort()
      Information provided by the PKI file:
      
          \brief Returns the port of this neighbor table.
          
          \return RouterPort, the RouterPort object of this neighbor table.
          
              
      Returns:
      RouterPort Returns a RouterPort
    • getAdjNeighborCount

      int getAdjNeighborCount()
      Information provided by the PKI file:
      
          \brief Returns the number of adjacent neighbors.
          
          \return int, the number of adjacent neighbors.
          
              
      Returns:
      int Returns a int
    • getAdjNeighborAt

      IPAddress getAdjNeighborAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the IP address of the adjacent neighbor at the specified index.
          
          \param index, the index of the adjacent neighbor of interest.
          
          \return ip, the IP address of the adjacent neighbor at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      IPAddress Returns a IPAddress
    • getFloodLength

      int getFloodLength()
      Information provided by the PKI file:
      
          \brief Returns the flood length.
          
          \return int, the flood length.
          
              
      Returns:
      int Returns a int
    • getLastFloodLength

      int getLastFloodLength()
      Information provided by the PKI file:
      
          \brief Returns the last flood length.
          
          \return int, the last flood length.
          
              
      Returns:
      int Returns a int
    • getMaxFloodLength

      int getMaxFloodLength()
      Information provided by the PKI file:
      
          \brief Returns the maximum flood length.
          
          \return int, the maximum flood length.
          
              
      Returns:
      int Returns a int
    • getLastFloodTime

      int getLastFloodTime()
      Information provided by the PKI file:
      
          \brief Returns the last flood time.
          
          \return int, the last flood time.
          
              
      Returns:
      int Returns a int
    • getMaxFloodTime

      int getMaxFloodTime()
      Information provided by the PKI file:
      
          \brief Returns the maximum flood time.
          
          \return int, the maximum flood time.
          
              
      Returns:
      int Returns a int